/**
 * Copyright (c) 2010 Basil Shikin, BugStat Project
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.bugstat.common.reports;

/**
 * This enum contains supported report types. See documentation for each
 * enum member for more info.
 *
 * @author Basil Shikin
 *
 */
public enum BugReportType
{
    /**
     * This is a simple y=f(x) graph.
     */
    GRAPH,
    
    /**
     * This is a graph with filled areas. One area would be displayed on top
     * of the other one. So, for y1=f1(x) and y2=f2(x) a graph with
     * two colors will be displayed:
     * 
     * <pre>
     *   |
     *   |          ____________ y1=f1(x)
     *   |         /           <------------ this area is red
     *   |   _____/   __________ y2=f2(x)
     *   |  /________/
     *   | /                   <------------ this area is green
     *   +------------------------>
     * </pre>
     */
    GRAPH_WITH_AREAS,
    
    
    /**
     * This is a bar chart with one bar at each key
     */
    BARS,
    
    
    /**
     * This is a bar chart with a number of bars at each key. For three
     * values (y1=f1(x), y2=f2(x), y3=f3(x):
     * 
     * <pre>
     *   |     +-+
     *   | +-+ |#|      +-+
     *   | |O| |#|      |#|
     *   | |O|-+#|    +-+#|
     *   | |O|X|#|  +-|X|#|
     *   | |O|X|#|  |O|X|#|
     *   +------------------->
     * </pre>
     */    
    BARS_COMPARION,
    
    
    /**
     * This is a bar chart, where each bar is divided into areas with different 
     * colors. For three values (y1=f1(x), y2=f2(x), y3=f3(x):
     * <pre>
     *   | +-+
     *   | |X|   +-+
     *   | +-+   |X|  <----- y3, blue
     *   | |#|   |X|
     *   | |#|   +-+
     *   | +-+   |#|  <----- y2, green
     *   | |O|   +-+
     *   | |O|   |0|  <----- y1, red
     *   | |O|   |0|
     *   +------------------->
     * </pre>
     */
    BARS_WITH_AREAS
}
